IWorkspace interface

Namespace: NextDesign.Desktop

Description

Provides access to workspace information for your application.

Affiliation area

Name Description
Workspace project API group to access the workspace of the application and the project opened in the application.

Property

Name Description
CurrentModel Model element selected in current project
Returns null if there is no model selected.
CurrentProject Current Project
Returns information about the project currently open in the application workspace.
Returns null if the application does not have a project open.
Errors Error List
You can access the error information currently registered using this object.
InfoDisplayStyleSet Defining a style set
This object allows you to manage the styles that can be specified when displaying errors and search results.
Output Output
You can use this object to access the output of your application.
Search Search
You can use this object to access the list of search results.

method

Name Description
CleanUpProject Cleans up the specified project.
If no project is specified, the current project opened in the application is cleaned up.

Project cleanup processing is performed only on the editable units of the managed units of the specified project.
If the target project has not been saved, calling this method will fail.
CloseProject Closes the specified project.
If no project is specified, the current project currently opened in the application is closed.

This call discards your changes and closes the project without warning, even if the target project has not been saved.
CreateSearch [Obsolete] Creates a search object.
Using this object, you can start and end the search and register the search results.
NewProject Creates a new project.
OpenProject Opens the specified project.
SaveProject Saves the specified project.
If no project is specified, save the current project currently opened in the application.
Returns True if the save was successful.
If you use this method in the situation that you cannot get the access right of the file, there is not enough free space, the project will not be saved, and this method will return False.

The save destination of the project is the path that can be obtained with IProject.Path.
Therefore, this method cannot be executed for a project that has not been saved since it was newly created.
When saving a new project, please use SaveProjectAs ().
SaveProjectAs Saves the specified project at the specified path.
If no project is specified, save the current project currently opened in the application.
Returns True if the save was successful.

This call will silently overwrite if the file already exists in the specified path.
If the save is successful, the target project Path will be replaced with the new path.